Documentation

The Documentation feature holds two links to external web pages, which host information about the APIs used in the CMP and the Enterprise Portal User Manual. These external web pages could be a branded environment created specifically for customer access, or customers may wish to set up a URL that links directly to their own web-hosted API documentation or Enterprise Portal User Manual.

Note:

The API Documentation link is intended only for Users whose role requires them to have knowledge of APIs. It is optional and will never be seen if no users possess the required Access Policy rights.

To access the Documentation feature, a User must possess the Access Policy rights Documentation Menu and Documentation URL. To access the API Documentation click the Documentation API link and you will be redirected to the documentation.

Note:

Documentation URL requires the Account Administrator to define the URL that directs to the Documentation. In case no documentation is available in the place of the documentation link the statement "No documentation available" will be displayed.